SpringCloud入门(2) Nacos配置管理 Feign远程调用 Gateway服务网关

您所在的位置:网站首页 feign nacos gateway SpringCloud入门(2) Nacos配置管理 Feign远程调用 Gateway服务网关

SpringCloud入门(2) Nacos配置管理 Feign远程调用 Gateway服务网关

2024-07-14 23:29:33| 来源: 网络整理| 查看: 265

继续上一节内容,继续学习SpringCloud,本节学习Nacos配置管理 Feign远程调用 Gateway服务网关三个部分

目录 1.Nacos配置管理1.1.统一配置管理1.2.配置热更新 @RefreshScope @ConfigurationProperties1.3.配置共享1.4.搭建Nacos集群 2.Feign远程调用2.1.Feign替代RestTemplate2.2.自定义配置2.2.1.配置文件方式2.2.2.Java代码方式 2.3.Feign使用优化2.4.最佳实践2.4.1.继承方式2.4.2.抽取方式2.4.3.实现基于抽取的最佳实践 3.Gateway服务网关3.1.为什么需要网关3.2.gateway快速入门3.3.断言工厂3.4.过滤器工厂3.4.1.路由过滤器的种类3.4.2.默认过滤器DefaultFilter 3.5.全局过滤器GlobalFilter默认、路由、全局三种过滤器执行顺序? 3.6.Gateway解决跨域问题

1.Nacos配置管理 1.1.统一配置管理

当微服务部署的实例越来越多,达到数十、数百时,逐个修改微服务配置就会让人抓狂,而且很容易出错。我们需要一种统一配置管理方案,可以集中管理所有实例的配置。

Nacos除了可以做注册中心,同样可以做配置管理来使用。Nacos一方面可以将配置集中管理,另一方可以在配置变更时,及时通知微服务,实现配置的热更新。

在这里插入图片描述

如何在nacos中管理配置呢?

在这里插入图片描述

然后在弹出的表单中,填写配置信息:

在这里插入图片描述

注意:项目的核心配置,需要热更新的配置才有放到nacos管理的必要。基本不会变更的一些配置还是保存在微服务本地比较好。

微服务要拉取nacos中管理的配置,并且与本地的application.yml配置合并,才能完成项目启动。但如果尚未读取application.yml,又如何得知nacos地址呢?

因此spring引入了一种新的配置文件:bootstrap.yaml文件,会在application.yml之前被读取,流程如下:

在这里插入图片描述

1)引入nacos-config依赖

首先,在user-service服务中,引入nacos-config的客户端依赖(不同于上一节的nacos-discovery):

com.alibaba.cloud spring-cloud-starter-alibaba-nacos-config

2)添加bootstrap.yaml

然后,在user-service中添加一个bootstrap.yaml文件,内容如下:

spring: application: name: userservice # 服务名称 profiles: active: dev #开发环境,这里是dev cloud: nacos: server-addr: localhost:8848 # Nacos地址 config: file-extension: yaml # 文件后缀名

这里会根据spring.cloud.nacos.server-addr获取nacos地址,再根据

${spring.application.name}-${spring.profiles.active}.${spring.cloud.nacos.config.file-extension}作为文件id,来读取配置。

本例中,就是去读取userservice-dev.yaml:

在这里插入图片描述

3)读取nacos配置

在user-service中的UserController中添加业务逻辑,读取我们在nacos中管理的配置信息:pattern.dateformat配置。

在这里插入图片描述

完整代码:

package cn.itcast.user.web; import cn.itcast.user.pojo.User; import cn.itcast.user.service.UserService; import lombok.extern.slf4j.Slf4j; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Value; import org.springframework.web.bind.annotation.*; import java.time.LocalDateTime; import java.time.format.DateTimeFormatter; @Slf4j @RestController @RequestMapping("/user") public class UserController { @Autowired private UserService userService; @Value("${pattern.dateformat}") private String dateformat; @GetMapping("now") public String now(){ return LocalDateTime.now().format(DateTimeFormatter.ofPattern(dateformat)); } // ...略 }

在页面访问,可以看到效果:

请添加图片描述

1.2.配置热更新 @RefreshScope @ConfigurationProperties

我们最终的目的,是修改nacos中的配置后,微服务中无需重启即可让配置生效,也就是配置热更新。要实现配置热更新,可以使用两种方式:

1.2.1.方式一

在@Value注入的变量所在类上添加注解@RefreshScope:

在这里插入图片描述

1.2.2.方式二

使用@ConfigurationProperties注解代替@Value注解。

在user-service服务中,添加一个类,读取patterrn.dateformat属性:

package cn.itcast.user.config; import lombok.Data; import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.stereotype.Component; @Component @Data @ConfigurationProperties(prefix = "pattern") public class PatternProperties { private String dateformat; }

在UserController中使用这个类代替@Value:

在这里插入图片描述

完整代码:

package cn.itcast.user.web; import cn.itcast.user.config.PatternProperties; import cn.itcast.user.pojo.User; import cn.itcast.user.service.UserService; import lombok.extern.slf4j.Slf4j; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; import java.time.LocalDateTime; import java.time.format.DateTimeFormatter; @Slf4j @RestController @RequestMapping("/user") public class UserController { @Autowired private UserService userService; @Autowired private PatternProperties patternProperties; @GetMapping("now") public String now(){ return LocalDateTime.now().format(DateTimeFormatter.ofPattern(patternProperties.getDateformat())); } // 略 }

重新运行微服务,访问页面后修改配置管理的时间pattern再刷新页面,可以看到返回的时间格式也发生变化。

1.3.配置共享

其实微服务启动时,会去nacos读取多个配置文件,例如:

[spring.application.name]-[spring.profiles.active].yaml,例如:userservice-dev.yaml

[spring.application.name].yaml,例如:userservice.yaml

而[spring.application.name].yaml不包含环境,因此可以被多个环境共享。

下面我们通过案例来测试配置共享

添加一个环境共享配置

我们在nacos中添加一个userservice.yaml文件:

在这里插入图片描述

在user-service中读取共享配置

在user-service服务中,修改PatternProperties类,读取新添加的属性:

在这里插入图片描述

在user-service服务中,修改UserController,添加一个方法:

在这里插入图片描述

运行两个UserApplication,使用不同的profile

修改UserApplication2这个启动项,改变其profile值:

在这里插入图片描述

在这里插入图片描述

这样,UserApplication(8081)使用的profile是dev,UserApplication2(8082)使用的profile是test。

启动UserApplication和UserApplication2

访问http://localhost:8081/user/prop,结果:

在这里插入图片描述

访问http://localhost:8082/user/prop,结果:

在这里插入图片描述

可以看出来,不管是dev,还是test环境,都读取到了envSharedValue这个属性的值。

配置共享的优先级

当nacos、服务本地同时出现相同属性时,优先级有高低之分:

在这里插入图片描述

1.4.搭建Nacos集群

之前我们都是使用的单点Nacos,Nacos生产环境下一定要部署为集群状态,官方给出的Nacos集群图:

在这里插入图片描述

其中包含3个nacos节点,然后一个负载均衡器代理3个Nacos。这里负载均衡器可以使用nginx。我们计划的集群结构:

在这里插入图片描述

三个nacos节点的地址: nacos1 192.168.150.1 8845 nacos2 192.168.150.1 8846 nacos3 192.168.150.1 8847

搭建集群的基本步骤:1.搭建数据库,初始化数据库表结构 2.下载nacos安装包 3.配置nacos 4.启动nacos集群 5.nginx反向代理

1.初始化数据库

Nacos默认数据存储在内嵌数据库Derby中,不属于生产可用的数据库。官方推荐的最佳实践是使用带有主从的高可用数据库集群,主从模式的高可用数据库可以参考传智教育的后续高手课程。这里以单点的数据库为例来讲解。

首先新建一个数据库,命名为nacos,然后导入课程资料SQL脚本(官方也有提供)。

2.下载nacos安装包 3.配置nacos

安装之前已经提过,进入nacos的conf目录,修改配置文件cluster.conf.example,重命名为cluster.conf:

在这里插入图片描述

然后添加内容配置集群中每一个节点的信息,我们这里都在本机所以都是localhost,如果是真实生产环境这里就是真实的三台机器的ip和各自的端口

127.0.0.1:8845 127.0.0.1:8846 127.0.0.1:8847

这里写成127.0.0.1我测试发现user服务可以正常注册,但是order服务怎么都注册不上,试了很多方法,最后将127.0.0.1改成自己本地的真实ip就行了,不太懂这里面的原理,order和user的配置文件都修改成一样的了,为什么只有order注册不上去,有知道这里面原理的大佬可以评论一下。

然后修改application.properties文件,添加数据库配置

spring.datasource.platform=mysql db.num=1 db.url.0=jdbc:mysql://127.0.0.1:3306/nacos?characterEncoding=utf8&connectTimeout=1000&socketTimeout=3000&autoReconnect=true&useUnicode=true&useSSL=false&serverTimezone=UTC db.user.0=root db.password.0=密码

4.启动

将nacos文件夹复制三份,分别命名为:nacos1、nacos2、nacos3

然后分别修改三个文件夹中的application.properties,nacos1的server.port=8845 nacos2的server.port=8846 nacos3的server.port=8847 然后分别启动三个nacos节点:startup.cmd 这里是集群启动运行即可 不像之前那种单点启动

启动之前别忘记先启动mysql服务(net start mysql),否则会因为连接不上数据库而导致启动失败。

5.nginx反向代理

找到课前资料提供的nginx安装包解压到任意非中文目录下,修改conf/nginx.conf文件,配置如下:

upstream nacos-cluster { # 配置集群负载均衡 没指定策略默认轮询 server 127.0.0.1:8845; server 127.0.0.1:8846; server 127.0.0.1:8847; } server { listen 80; server_name localhost; location /nacos { proxy_pass http://nacos-cluster; } }

如上代码的含义是:监听80端口号, 然后当我们访问 http://localhost:80/nacos/…/…这样的接口的时候,它会通过 location /nacos/ {} 这样的反向代理到 http://nacos-cluster上来,而nacos-cluster我们已经在上面指定了三个地址。

而后在浏览器访问:http://localhost/nacos即可(http默认端口就是80无需指定了)。 代码中需要修改application.yml文件配置如下:

spring: cloud: nacos: server-addr: localhost:80 # Nacos地址

6.优化

实际部署时,需要给做反向代理的nginx服务器设置一个域名,这样后续如果有服务器迁移nacos的客户端也无需更改配置.

Nacos的各个节点应该部署到多个不同服务器,做好容灾和隔离

2.Feign远程调用

先来看我们以前利用RestTemplate发起远程调用的代码:

在这里插入图片描述

存在下面的问题:

•代码可读性差,编程体验不统一

•参数复杂URL难以维护

Feign是一个声明式的http客户端,官方地址

其作用就是帮助我们优雅的实现http请求的发送,解决上面提到的问题。

在这里插入图片描述

2.1.Feign替代RestTemplate

Fegin的使用步骤如下:

1)引入依赖

我们在order-service服务的pom文件中引入feign的依赖:

org.springframework.cloud spring-cloud-starter-openfeign

2)添加注解

在order-service的启动类添加注解@EnableFeignClients开启Feign的功能:

在这里插入图片描述

3)编写Feign的客户端

在order-service中的client包下新建一个接口,内容如下:

package cn.itcast.order.client; import cn.itcast.order.pojo.User; import org.springframework.cloud.openfeign.FeignClient; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PathVariable; @FeignClient("userservice") public interface UserClient { @GetMapping("/user/{id}") User findById(@PathVariable("id") Long id); }

这个客户端主要是基于SpringMVC的注解来声明远程调用的信息,比如:

服务名称:userservice请求方式:GET请求路径:/user/{id}请求参数:Long id返回值类型:User

这样,Feign就可以帮助我们发送http请求,无需自己使用RestTemplate来发送了。

4)测试

修改order-service中的OrderService类中的queryOrderById方法,使用Feign客户端代替RestTemplate:

在这里插入图片描述

是不是看起来优雅多了。

重启服务,调用http://localhost:8080/order/101,发现调用成功,返回的数据成功携带用户数据。

5)总结

使用Feign的步骤:

① 引入依赖

② 添加@EnableFeignClients注解

③ 编写FeignClient接口

④ 使用FeignClient中定义的方法代替RestTemplate

2.2.自定义配置

Spirng Boot虽然帮我们实现了自动装配,但也是允许我们覆盖配置的,Feign可以支持很多的自定义配置,部分配置如下表所示:

类型作用说明feign.Logger.Level修改日志级别包含四种不同的级别:NONE(默认不记录)、BASIC(基本信息,记录发起一次http请求时记录请求的发送与结束时间,耗时时间)、HEADERS(除了基本信息外还有请求头和响应头信息)、FULL(还会把请求体和响应体信息记录下来)feign.codec.Decoder响应结果的解析器http远程调用的结果做解析,例如解析json字符串为java对象feign.codec.Encoder请求参数编码将请求参数编码,便于通过http请求发送feign. Contract支持的注解格式规定Feign支持哪些注解,默认是支持SpringMVC的注解,所以一般这个不去动他feign. Retryer失败重试机制请求失败的重试机制,默认是没有,不过Feign底层是依赖于Ribbon的,会使用Ribbon的重试

一般情况下,默认值就能满足我们使用,如果要自定义时,只需要创建自定义的@Bean覆盖默认Bean即可。

下面以日志为例来演示如何自定义配置。

2.2.1.配置文件方式

基于order的配置文件修改feign的日志级别可以针对单个服务:

feign: client: config: userservice: # 针对某个微服务的配置 loggerLevel: FULL # 日志级别

也可以针对所有服务:

feign: client: config: default: # 这里用default就是全局配置,如果是写服务名称,则是针对访问某个微服务的配置 loggerLevel: FULL # 日志级别

而日志的级别分为四种:

NONE:不记录任何日志信息,这是默认值。BASIC:仅记录请求的方法,URL以及响应状态码和执行时间HEADERS:在BASIC的基础上,额外记录了请求和响应的头信息FULL:记录所有请求和响应的明细,包括头信息、请求体、元数据。

我们测试一下FULL的效果,修改order的application.yml,添加上面的配置,重启服务,调用查询接口,可以看到控制台的输出:

请添加图片描述

可以看到日志级别为FULL时,除了sql语句之外,UserClinet发起get请求,请求方式、路径、协议,结束响应的状态码、调用速度,响应头,响应体信息都显示出来了。

2.2.2.Java代码方式

也可以基于Java代码来修改日志级别,先可以在配置类的包下声明一个类,然后在里面声明一个Logger.Level的对象:

package cn.itcast.order.config; import feign.Logger; import org.springframework.context.annotation.Bean; public class DefaultFeignConfiguration { @Bean public Logger.Level feignLogLevel(){ return Logger.Level.BASIC; // 日志级别为BASIC } }

但是没有加注解这个配置不会生效。

如果要全局生效,将其放到启动类的@EnableFeignClients这个注解中:

@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class)

如果是局部生效,则把它放到对应的@FeignClient这个注解中:

@FeignClient(value = "userservice", configuration = DefaultFeignConfiguration .class)

重启服务测试日志级别为BASIC:

请添加图片描述

2.3.Feign使用优化

Feign底层发起http请求,依赖于其它的框架。其底层客户端实现包括:

•URLConnection:默认实现,不支持连接池

•Apache HttpClient :支持连接池

•OKHttp:支持连接池

因此提高Feign的性能主要手段就是使用连接池代替默认的URLConnection。

这里我们用Apache的HttpClient来演示。

1)引入依赖

在order-service的pom文件中引入Apache的HttpClient依赖:

io.github.openfeign feign-httpclient

2)配置连接池

在order-service的application.yml中添加配置:

feign: client: config: default: # default全局的配置 loggerLevel: BASIC # 日志级别,BASIC就是基本的请求和响应信息 httpclient: enabled: true # 开启feign对HttpClient的支持 max-connections: 200 # 最大的连接数 max-connections-per-route: 50 # 每个路径的最大连接数

接下来,在FeignClientFactoryBean中的loadBalance方法中打断点:

在这里插入图片描述

Debug方式启动order-service服务,可以看到这里的client,底层就是Apache HttpClient:

在这里插入图片描述

总结,Feign的优化:

1.日志级别尽量用basic

2.使用HttpClient或OKHttp代替URLConnection

① 引入feign-httpClient依赖

② 配置文件开启httpClient功能,设置连接池参数

2.4.最佳实践

所谓最近实践,就是使用过程中总结的经验,最好的一种使用方式。

观察可以发现,Feign的客户端与服务提供者的controller代码非常相似:

feign客户端:

在这里插入图片描述

UserController:

在这里插入图片描述

有没有一种办法简化这种重复的代码编写呢?

2.4.1.继承方式

一样的代码可以通过继承来共享:

1)定义一个API接口,利用定义方法,并基于SpringMVC注解做声明。

2)Feign客户端和Controller都集成改接口

在这里插入图片描述

优点:

简单实现了代码共享

缺点:

服务提供方、服务消费方紧耦合

参数列表中的注解映射并不会继承,因此Controller中必须再次声明方法、参数列表、注解

2.4.2.抽取方式

将Feign的Client抽取为独立模块,并且把接口有关的POJO、默认的Feign配置都放到这个模块中,提供给所有消费者使用,这样每个服务调用者就不需要在自己的代码里写重复的调用逻辑了。

例如,将UserClient、User、Feign的默认配置都抽取到一个feign-api包中,所有微服务引用该依赖包,即可直接使用。

请添加图片描述

在这里插入图片描述

2.4.3.实现基于抽取的最佳实践

1)抽取

首先创建一个module,命名为feign-api:

在这里插入图片描述

项目结构:

在这里插入图片描述

在feign-api中然后引入feign的starter依赖

org.springframework.cloud spring-cloud-starter-openfeign

然后,order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中

在这里插入图片描述

2)在order-service中使用feign-api

首先,删除order-service中的UserClient、User、DefaultFeignConfiguration等类或接口。

在order-service的pom文件中中引入feign-api的依赖:

cn.itcast.demo feign-api 1.0

修改order-service中的所有与上述三个组件有关的导包部分,删除原来的导包路径,改成导入feign-api中的包

3)重启测试

重启后,发现服务报错了:

在这里插入图片描述

这是因为UserClient现在在cn.itcast.feign.clients包下,之前是因为我们通过order-service启动类的@EnableFeignClients注解扫描到了UserClient下的@FeignClient注解。

而现在order-service的@EnableFeignClients注解是在cn.itcast.order包下,不在同一个包,无法扫描到UserClient。

4)解决扫描包问题

当定义的FeignClient不在SpringBootApplication的扫描包范围时,这些Feignclient无法使用。有两种方式解决:

方式一:

指定Feign应该扫描的包,批量导入包内所有的客户端:

@EnableFeignClients(basePackages = "cn.itcast.feign.clients")

方式二:

指定需要加载的Client接口,精准打击,只导入指定的这一个或多个:

@EnableFeignClients(clients = {UserClient.class})

重启服务调用接口,测试发现成功。

3.Gateway服务网关

Spring Cloud Gateway 是 Spring Cloud 的一个全新项目,该项目是基于 Spring 5.0,Spring Boot 2.0 和 Project Reactor 等响应式编程和事件流技术开发的网关,它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。

3.1.为什么需要网关

Gateway网关是我们服务的守门神,所有微服务的统一入口。

网关的核心功能特性:

请求路由权限控制限流

架构图:

在这里插入图片描述

权限控制:网关作为微服务入口,需要校验用户是是否有请求资格,如果没有则进行拦截。

路由和负载均衡:一切请求都必须先经过gateway,但网关不处理业务,而是根据某种规则,把请求转发到某个微服务,这个过程叫做路由。当然路由的目标服务有多个时,还需要做负载均衡。

限流:当请求流量过高时,在网关中按照下流的微服务能够接受的速度来放行请求,避免服务压力过大。

在SpringCloud中网关的实现包括两种:

gatewayzuul

Zuul是基于Servlet的实现,属于阻塞式编程。而SpringCloudGateway则是基于Spring5中提供的WebFlux,属于响应式编程的实现,具备更好的性能。

3.2.gateway快速入门

下面,我们就演示下网关的基本路由功能。基本步骤如下:

创建SpringBoot工程gateway,引入网关依赖编写启动类编写基础配置和路由规则启动网关服务进行测试

1)创建gateway服务,引入依赖

创建服务:

在这里插入图片描述

引入依赖,网关本身也是个微服务,它也需要把自注册到nacos,或者到nacos上去拉取服务,所以也需要引入nacos

org.springframework.cloud spring-cloud-starter-gateway com.alibaba.cloud spring-cloud-starter-alibaba-nacos-discovery

2)编写启动类

package cn.itcast.gateway; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication public class GatewayApplication { public static void main(String[] args) { SpringApplication.run(GatewayApplication.class, args); } }

3)编写基础配置和路由规则

创建application.yml文件,内容如下:

server: port: 10010 # 网关端口 spring: application: name: gateway # 服务名称 cloud: nacos: server-addr: localhost:8848 # nacos地址 默认是8848端口 如果采用了上面的集群部署 就要填nginx的80端口 gateway: routes: # 网关路由配置 - id: user-service # 路由id,自定义,只要唯一即可 # uri: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址 uri: lb://userservice # 路由的目标地址 lb就是负载均衡,后面跟服务名称 predicates: # 路由断言,也就是判断请求是否符合路由规则的条件 - Path=/user/** # 这个是按照路径匹配,只要以/user/开头就符合要求

我们将符合Path 规则的一切请求,都代理到 uri参数指定的地址。

本例中,我们将 /user/**开头的请求,代理到lb://userservice,lb是负载均衡,根据服务名拉取服务列表,实现负载均衡。

4)重启测试

重启网关,访问http://localhost:10010/user/1时,符合/user/**规则,请求转发到uri:http://userservice/user/1,得到了结果:

在这里插入图片描述

5)网关路由的流程图

整个访问的流程如下:

在这里插入图片描述

总结:

网关搭建步骤:

创建项目,引入nacos服务发现和gateway依赖

配置application.yml,包括服务基本信息、nacos地址、路由

路由配置包括:

路由id:路由的唯一标示

路由目标(uri):路由的目标地址,http代表固定地址,lb代表根据服务名负载均衡

路由断言(predicates):判断路由的规则,

路由过滤器(filters):对请求或响应做处理

接下来,就重点来学习路由断言和路由过滤器的详细知识

3.3.断言工厂

我们在配置文件中写的断言规则只是字符串,这些字符串会被Predicate Factory读取并处理,转变为路由判断的条件

例如我们上面写的Path=/user/**是按照路径匹配,这个规则是由

org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来处理的,像这样的断言工厂在SpringCloudGateway还有十几个:

名称说明示例After是某个时间点后的请求- After=2037-01-20T17:42:47.789-07:00[America/Denver]Before是某个时间点之前的请求- Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai]Between是某两个时间点之前的请求- Between=2037-01-20T17:42:47.789-07:00[America/Denver], 2037-01-21T17:42:47.789-07:00[America/Denver]Cookie请求必须包含某些cookie- Cookie=chocolate, ch.pHeader请求必须包含某些header- Header=X-Request-Id, \d+Host请求必须是访问某个host(域名)- Host=.somehost.org,.anotherhost.orgMethod请求方式必须是指定方式- Method=GET,POSTPath请求路径必须符合指定规则- Path=/red/{segment},/blue/**Query请求参数必须包含指定参数- Query=name, Jack或者- Query=nameRemoteAddr请求者的ip必须是指定范围- RemoteAddr=192.168.1.1/24Weight权重处理

具体这些断言工程的断言语句可以去官网学习查看。

我们这里尝试一下使用After断言:

server: port: 10010 # 网关端口 spring: application: name: gateway # 服务名称 cloud: nacos: server-addr: localhost:80 # nacos地址 gateway: routes: # 网关路由配置 - id: user-service # 路由id,自定义,只要唯一即可 # uri: http://127.0.0.1:8081 # 路由的目标地址 http就是固定地址 uri: lb://userservice # 路由的目标地址 lb就是负载均衡,后面跟服务名称 predicates: # 路由断言,也就是判断请求是否符合路由规则的条件 - Path=/user/** # 这个是按照路径匹配,只要以/user/开头就符合要求 - id: order-service uri: lb://orderservice predicates: - Path=/order/** - After=2037-01-20T17:42:47.789-07:00[Asia/Shanghai]

重启测试发现,user接口可以访问,order接口却访问不了,报错404,因为我们指定了2037年之后才可以访问

3.4.过滤器工厂

GatewayFilter是网关中提供的一种过滤器,可以对进入网关的请求和微服务返回的响应做处理:

在这里插入图片描述

3.4.1.路由过滤器的种类

Spring提供了31种不同的路由过滤器工厂,具体要用哪种可以参考官方文档,官网文档都对每种过滤器工厂写了说明和使用示例,还是比较好上手使用的。

名称说明AddRequestHeader给当前请求添加一个请求头RemoveRequestHeader移除请求中的一个请求头AddResponseHeader给响应结果中添加一个响应头RemoveResponseHeader从响应结果中移除有一个响应头RequestRateLimiter限制请求的流量

请求头过滤器

下面我们以AddRequestHeader 为例来讲解。

需求:给所有进入userservice的请求添加一个请求头:Truth=itcast is freaking awesome!

只需要修改gateway服务的application.yml文件,添加路由过滤即可:

spring: cloud: gateway: routes: - id: user-service uri: lb://userservice predicates: - Path=/user/** filters: # 过滤器 - AddRequestHeader=Truth, Itcast is freaking awesome! # 添加请求头 注意逗号可不是表示有两个参数的意思 而是逗号前为key 逗号后为value

当前过滤器写在userservice路由下,因此仅仅对访问userservice的请求有效。重启gateway服务,并且修改userservice的controller方法去获取请求头验证过滤器是否加上了请求头,这里我给出两种获取请求头的方法以供学习 第一种 直接去IOC容器中获取HttpServletRequest 也可以在方法参数里去声明HttpServletRequest,IOC容器会自动注入 第二种 通过在方法参数中使用@RequestHeader注解获取,required设置为false表示不强制要求有这个请求头参数

@Slf4j @RestController @RequestMapping("/user") public class UserController { ... @Autowired private HttpServletRequest httpServletRequest; ... /** * 路径: /user/110 * * @param id 用户id * @return 用户 */ @GetMapping("/{id}") public User queryById(@PathVariable("id") Long id, @RequestHeader(value = "Truth", required = false) String truth) { System.out.println("truth:"+truth); System.out.println(httpServletRequest.getHeader("truth")); return userService.queryById(id); }

重启服务访问,可以看到控制台成功的输出了两次请求头信息。

请添加图片描述

3.4.2.默认过滤器DefaultFilter

如果要对所有的路由都生效,则可以将过滤器工厂写到default下。格式如下:

spring: cloud: gateway: routes: - id: user-service uri: lb://userservice predicates: - Path=/user/** default-filters: # 默认过滤项 - AddRequestHeader=Truth, Itcast is freaking awesome!

3.4.3.总结

过滤器的作用是什么?

① 对路由的请求或响应做加工处理,比如添加请求头

② 配置在路由下的过滤器只对当前路由的请求生效

defaultFilters的作用是什么?

① 对所有路由都生效的过滤器

3.5.全局过滤器GlobalFilter

上一节学习的过滤器,网关提供了31种,但每一种过滤器的作用都是固定的。如果我们希望拦截请求,做自己的业务逻辑则没办法实现。

3.5.1.全局过滤器作用

全局过滤器的作用也是处理一切进入网关的请求和微服务响应,与GatewayFilter的作用一样。区别在于GatewayFilter通过配置定义,处理逻辑是固定的;而GlobalFilter的逻辑需要自己写代码实现。

定义方式是实现GlobalFilter接口。通过ServerWebExchange编写业务逻辑,通过GatewayFilterChain进行放行操作,返回值Mono类型是WebFlux中定义的。

public interface GlobalFilter { /** * 处理当前请求,有必要的话通过{@link GatewayFilterChain}将请求交给下一个过滤器处理 * * @param exchange 请求上下文,里面可以获取Request、Response等信息,还可以往里面存东西,从请求进入网关到结束为止整个流程都共享这个Exchange对象 * @param chain 用来把请求委托给下一个过滤器 * @return {@code Mono} 返回标示当前过滤器业务结束 */ Mono filter(ServerWebExchange exchange, GatewayFilterChain chain); }

在filter中编写自定义逻辑,可以实现下列功能:

登录状态判断权限校验请求限流等

3.5.2.自定义全局过滤器

需求:定义全局过滤器,拦截请求判断用于身份,判断请求的参数是否满足下面条件:

参数中是否有authorization,

authorization参数值是否为admin

如果同时满足则放行,否则拦截,在gateway中定义一个过滤器并实现GlobalFilter接口,重写filter方法:

package cn.itcast.gateway; import org.springframework.cloud.gateway.filter.GatewayFilterChain; import org.springframework.cloud.gateway.filter.GlobalFilter; import org.springframework.core.annotation.Order; import org.springframework.http.HttpStatus; import org.springframework.http.server.reactive.ServerHttpRequest; import org.springframework.stereotype.Component; import org.springframework.util.MultiValueMap; import org.springframework.web.server.ServerWebExchange; import reactor.core.publisher.Mono; @Order(-1) //使用Order注解定义多个过滤器的执行顺序 默认值为2147483647 值越小优先级越高 这个我们在学习AOP声明通知顺序的时候使用到过 @Component//为了让过滤器生效需要注册为bean public class AuthorizeFilter implements GlobalFilter { @Override public Mono filter(ServerWebExchange exchange, GatewayFilterChain chain) { //1.获取请求参数 注意这里是ServerHttpRequest而不是HttpServletRequest ServerHttpRequest request=exchange.getRequest(); MultiValueMap params = request.getQueryParams(); // 2.获取authorization参数 一般用getFirst获取第一个匹配的 String auth = params.getFirst("authorization"); // 3.校验 if ("admin".equals(auth)) { // 4.放行 调用下一个过滤器 filter的返回值就是Mono return chain.filter(exchange); } // 5.拦截 // 5.1.禁止访问,设置状态码401 这里传入的是枚举类型 exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED); // 5.2.结束处理 setComplete返回值也是Mono return exchange.getResponse().setComplete(); } }

注意这里获取请求参数时用的是ServerHttpRequest类,简单说 HttpServletRequest 是tomcat提供的。ServerHttpRequest 是 spring框架提供的。ServletServerHttpRequest 将 HttpServletRequest 作为自己的一个成员属性。

此时重启网关服务,访问用户接口localhost:10010/user/1发现报401错误,不允许访问了。带上参数就可以成功访问:localhost:10010/user/1?authorization=admin

这里通过@order注解来定义过滤器的执行顺序,还可以通过实现Ordered接口实现,效果与@order是一样的,值越小优先级越高

@Component//为了让过滤器生效需要注册为bean public class AuthorizeFilter implements GlobalFilter, Ordered { ... @Override public int getOrder() { return -1; } 默认、路由、全局三种过滤器执行顺序?

请求进入网关会碰到三类过滤器:当前路由的过滤器、DefaultFilter、GlobalFilter

请求路由后,会将当前路由过滤器和DefaultFilter、GlobalFilter,合并到一个过滤器链(集合)中,排序后依次执行每个过滤器:

在这里插入图片描述

排序的规则是什么呢?

每一个过滤器都必须指定一个int类型的order值,order值越小,优先级越高,执行顺序越靠前。GlobalFilter通过实现Ordered接口,或者添加@Order注解来指定order值,由我们自己指定路由过滤器和defaultFilter的order由Spring指定,默认是按照声明顺序从1递增。当过滤器的order值一样时,会按照 defaultFilter > 路由过滤器 > GlobalFilter的顺序执行。

详细内容,可以查看源码:

org.springframework.cloud.gateway.route.RouteDefinitionRouteLocator#getFilters()方法是先加载defaultFilters,然后再加载某个route的filters,然后合并。

org.springframework.cloud.gateway.handler.FilteringWebHandler#handle()方法会加载全局过滤器,与前面的过滤器合并后根据order排序,组织过滤器链

3.6.Gateway解决跨域问题

3.6.1.什么是跨域问题

跨域:域名不一致就是跨域,主要包括:

域名不同: www.taobao.com 和 www.taobao.org 和 www.jd.com 和 miaosha.jd.com

域名相同,端口不同:localhost:8080和localhost8081

跨域问题:浏览器禁止请求的发起者与服务端发生跨域ajax请求,请求被浏览器拦截的问题

解决方案:CORS或者JsonP,这个以前应该学习过,这里不再赘述了。不知道的小伙伴可以查看这篇博客或者这篇博客

3.6.2.模拟跨域问题

找到课前资料的页面文件:

在这里插入图片描述

放入tomcat或者nginx这样的web服务器中,启动并访问。

可以在浏览器控制台看到下面的错误:

在这里插入图片描述

从localhost:8090访问localhost:10010,端口不同,显然是跨域的请求。

3.6.3.解决跨域问题

gatewayt其实也是使用的CORS方案,在在gateway服务的application.yml文件中,添加下面的配置,去配置允许哪些网站的跨域请求和允许的跨域ajax的请求方式:

spring: cloud: gateway: # 。。。 globalcors: # 全局的跨域处理 add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题 corsConfigurations: '[/**]': allowedOrigins: # 允许哪些网站的跨域请求 - "http://localhost:8090" allowedMethods: # 允许的跨域ajax的请求方式 - "GET" - "POST" - "DELETE" - "PUT" - "OPTIONS" allowedHeaders: "*" # 允许在请求中携带的头信息 allowCredentials: true # 是否允许携带cookie maxAge: 360000 # 这次跨域检测的有效期


【本文地址】

公司简介

联系我们

今日新闻


点击排行

实验室常用的仪器、试剂和
说到实验室常用到的东西,主要就分为仪器、试剂和耗
不用再找了,全球10大实验
01、赛默飞世尔科技(热电)Thermo Fisher Scientif
三代水柜的量产巅峰T-72坦
作者:寞寒最近,西边闹腾挺大,本来小寞以为忙完这
通风柜跟实验室通风系统有
说到通风柜跟实验室通风,不少人都纠结二者到底是不
集消毒杀菌、烘干收纳为一
厨房是家里细菌较多的地方,潮湿的环境、没有完全密
实验室设备之全钢实验台如
全钢实验台是实验室家具中较为重要的家具之一,很多

推荐新闻


图片新闻

实验室药品柜的特性有哪些
实验室药品柜是实验室家具的重要组成部分之一,主要
小学科学实验中有哪些教学
计算机 计算器 一般 打孔器 打气筒 仪器车 显微镜
实验室各种仪器原理动图讲
1.紫外分光光谱UV分析原理:吸收紫外光能量,引起分
高中化学常见仪器及实验装
1、可加热仪器:2、计量仪器:(1)仪器A的名称:量
微生物操作主要设备和器具
今天盘点一下微生物操作主要设备和器具,别嫌我啰嗦
浅谈通风柜使用基本常识
 众所周知,通风柜功能中最主要的就是排气功能。在

专题文章

    CopyRight 2018-2019 实验室设备网 版权所有 win10的实时保护怎么永久关闭